﻿// Copyright 2017 the original author or authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

using System.Collections.Generic;

namespace Steeltoe.Common.Discovery
{
    public interface IServiceInstanceProvider
    {
        /// <summary>
        /// Gets a human readable description of the implementation
        /// </summary>
        string Description { get; }

        /// <summary>
        /// Gets all known service Ids
        /// </summary>
        IList<string> Services { get; }

        /// <summary>
        /// Get all ServiceInstances associated with a particular serviceId
        /// </summary>
        /// <param name="serviceId">the serviceId to lookup</param>
        /// <returns>List of service instances</returns>
        IList<IServiceInstance> GetInstances(string serviceId);
    }
}
